ISCModelObjectCollection

The ISCModelObjectCollection interface is a collection of objects in the model that is connected to the active session. Membership in this collection can be limited by establishing filter criteria.

The following table contains the methods for the ISCModelObjectCollection interface:

Method

Description

IUnknown _NewEnum()

Constructs an instance of the collection enumerator object.

ISCModelObject * Add(VARIANT Class, VARIANT ObjectId)

Adds an object of type Class to the model.

SC_CLSID * ClassIds()

Returns a SAFEARRAY of class identifiers (such as object type IDs).

Represents a value of the Model Object collection attribute that limited the membership in the collection at the time when this collection was created and can be used for reference purposes.

ClassIds contains a list of acceptable class identifiers (such as object types). If this list is non-empty, the collection includes only those objects whose class identifier appears in the list. If the list is empty or returns a NULL pointer, then all objects are included.

BSTR * ClassNames()

Similar to ClassIds except that it returns a SAFEARRAY of class names (such as object type names).

ISCModelObjectCollection * Collect(VARIANT Root, VARIANT ClassId [optional], VARIANT Depth [optional], VARIANT MustBeOn [optional], VARIANT MustBeOff [optional])

Creates a collection of Model Objects, which represents a subcollection of itself. All filtering criteria specified in the Collect call is applied toward membership in the collection.

The method creates a valid collection even though the collection may be empty.

All enumerations are depth-first.

long Count()

Number of objects in the collection. The number does not include the root object.

long Depth()

Depth limit on iteration in the collection. -1 represents unlimited depth.

ISCModelObject * Item(VARIANT nIndex, VARIANT Class [optional])

Returns an IUnknown pointer for a Model Object component identified by the Index parameter.

SC_ModelObjectFlags MustBeOff()

Filter on model object flags in the collection.

SC_ModelObjectFlags MustBeOn()

Filter on model object flags in the collection.

VARIANT_BOOL Remove(VARIANT Object)

Removes the specified model object from a model.

ISCModelObject * Root()

Returns a pointer to the root object in a collection.

For information about valid object class names and identifiers, see the HTML document erwin Metamodel Reference, in the Metamodel Reference Bookshelf located in the erwin Data Modeler installation folder.